Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

restructuring terminus install and update instructions #9401

Merged
merged 7 commits into from
Feb 5, 2025

Conversation

stevector
Copy link
Contributor

Fixes #8755 by restructuring/rewriting https://docs.pantheon.io/terminus/install

I am making this PR while co-working with @jazzsequence. @rachelwhitton can you review? We've mostly copy/pasted existing text into a slightly different ordering of headings. We've also removed references to old installation techniques like apt and composer-managed.

source/content/terminus/02-install.md Outdated Show resolved Hide resolved
source/content/terminus/02-install.md Outdated Show resolved Hide resolved

### Self:update not defined
## Installing and Updating Terminus Plugins
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we have a section for installing and updating terminus plugins, i would expect terminus self:plugin:update to be in the documentation, but in this case we just link out to the plugin directory.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I say delete this section from this page, it's already documented on another page.

If the steps were different based on terminus installed via PHAR vs homebrew, then it would be helpful to cover plugin installation/updates in those contexts but otherwise it's just adding noise instead of value I think

Copy link

⚡ Deployed with Pantheon Decoupled

This build was successfully deployed with Pantheon. You can track the build logs here.

👀 Preview: https://pr-9401-documentation.appa.pantheon.site
🛠️ Manage in Pantheon: https://dashboard.pantheon.io/site/2b30153f-e8b1-4427-b076-6109e704ba5d/overview

Copy link
Contributor

@jms-pantheon jms-pantheon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree this page needed an overall, and removing non-recommended install paths is great.

My only question is on why we moved incompatible systems to be separate from compatible? Not a deal-breaker but seemed a bit odd in the hierarchy to me

Copy link

⚡ Deployed with Pantheon Decoupled

This build was successfully deployed with Pantheon. You can track the build logs here.

👀 Preview: https://pr-9401-documentation.appa.pantheon.site
🛠️ Manage in Pantheon: https://dashboard.pantheon.io/site/2b30153f-e8b1-4427-b076-6109e704ba5d/overview

Copy link

⚡ Deployed with Pantheon Decoupled

This build was successfully deployed with Pantheon. You can track the build logs here.

👀 Preview: https://pr-9401-documentation.appa.pantheon.site
🛠️ Manage in Pantheon: https://dashboard.pantheon.io/site/2b30153f-e8b1-4427-b076-6109e704ba5d/overview

Copy link

⚡ Deployed with Pantheon Decoupled

This build was successfully deployed with Pantheon. You can track the build logs here.

👀 Preview: https://pr-9401-documentation.appa.pantheon.site
🛠️ Manage in Pantheon: https://dashboard.pantheon.io/site/2b30153f-e8b1-4427-b076-6109e704ba5d/overview

Copy link

⚡ Deployed with Pantheon Decoupled

This build was successfully deployed with Pantheon. You can track the build logs here.

👀 Preview: https://pr-9401-documentation.appa.pantheon.site
🛠️ Manage in Pantheon: https://dashboard.pantheon.io/site/2b30153f-e8b1-4427-b076-6109e704ba5d/overview

Copy link

⚡ Deployed with Pantheon Decoupled

This build was successfully deployed with Pantheon. You can track the build logs here.

👀 Preview: https://pr-9401-documentation.appa.pantheon.site
🛠️ Manage in Pantheon: https://dashboard.pantheon.io/site/2b30153f-e8b1-4427-b076-6109e704ba5d/overview

1 similar comment
Copy link

⚡ Deployed with Pantheon Decoupled

This build was successfully deployed with Pantheon. You can track the build logs here.

👀 Preview: https://pr-9401-documentation.appa.pantheon.site
🛠️ Manage in Pantheon: https://dashboard.pantheon.io/site/2b30153f-e8b1-4427-b076-6109e704ba5d/overview

@rachelwhitton
Copy link
Member

rachelwhitton commented Jan 30, 2025

My copy review was very heavy handed so I branched it off in another PR #9406

@stevector @jazzsequence @jms-pantheon can ya'll take a look?

Multidev preview: https://multi-8755-documentation.appa.pantheon.site/terminus/install

* Restructure the restructure

* Align headers

* Align with updated header

* Simpler headers, combine install and update subsections

* Linux instead of ubuntu

* Combine macos intro copy

* Add alert for wls install pre-req

* Update source/content/terminus/02-install.md

Co-authored-by: Chris Reynolds <[email protected]>

* Update source/content/terminus/02-install.md

Co-authored-by: Chris Reynolds <[email protected]>

---------

Co-authored-by: Chris Reynolds <[email protected]>
@rachelwhitton
Copy link
Member

Got a 👍 review from @jazzsequence and @jms-pantheon for my copy reviews in #9406 so I merged it here

@stevector can you review when convenient?

@rachelwhitton rachelwhitton self-requested a review February 4, 2025 19:08
Copy link

⚡ Deployed with Pantheon Decoupled

This build was successfully deployed with Pantheon. You can track the build logs here.

👀 Preview: https://pr-9401-documentation.appa.pantheon.site
🛠️ Manage in Pantheon: https://dashboard.pantheon.io/site/2b30153f-e8b1-4427-b076-6109e704ba5d/overview

@rachelwhitton rachelwhitton merged commit de5ab54 into main Feb 5, 2025
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Terminus Guide Doc Link
4 participants